S08-03 Node-包管理工具
[TOC]
概述
代码共享方案
代码共享需求:我们已经学习了在 JavaScript 中可以通过模块化的方式将代码划分成一个个小的结构:
- 在以后的开发中我们就可以通过模块化的方式来封装自己的代码,并且封装成一个工具;
- 这个工具我们可以让同事通过导入的方式来使用,甚至你可以分享给世界各地的程序员来使用;
代码共享方案:
如果我们分享给世界上所有的程序员使用,有哪些方式呢?
方式一:上传 GitHub/官网发布
上传到 GitHub 上、其他程序员通过 GitHub 下载我们的代码手动的引用;
缺点:
必须知晓地址并手动下载:大家必须知道你的代码 GitHub 的地址,并且从 GitHub 上手动下载;
手动引入并关联依赖:
需要在自己的项目中手动的引用,并且管理相关的依赖;
不需要使用的时候,需要手动来删除相关的依赖;
当遇到版本升级或者切换时,需要重复上面的操作;
显然,上面的方式是有效的,但是这种传统的方式非常麻烦,并且容易出错;
方式二:包管理工具
使用一个专业的工具来管理我们的代码,
发布:我们通过工具将代码发布到特定的位置;
安装:其他程序员直接通过工具来安装、升级、删除我们的工具代码;
显然,通过第二种方式我们可以更好的管理自己的工具包,其他人也可以更好的使用我们的工具包。
npm
npm 介绍
npm(Node Package Manager,Node 包管理器):是 Node.js 官方内置的包管理工具,也是 JavaScript 生态中最成熟、使用最广泛的包管理系统。它不仅用于管理项目依赖(如 React、Vue、Express 等),还提供了包发布、版本控制、脚本运行等核心功能,是 Node.js 开发的基础工具之一。
下载/安装 npm:安装 Node.js 时会自动附带 npm(无需单独安装),开箱即用。
npm 搜索/安装包:
- npm 官网:https://www.npmjs.com/
包存放位置:npm registry
- 发布包:我们发布自己的包其实是发布到 registry 上面的;
- 安装包:当我们安装一个包时其实是从 registry 上面下载的包;
package.json
概述
事实上,我们每一个项目都会有一个对应的配置文件,无论是前端项目还是后端项目:
- 这个配置文件会记录着你项目的名称、版本号、项目描述等;
- 也会记录着你项目所依赖的其他库的信息和依赖库的版本号;
这个配置文件在 Node 环境下面(无论是前端还是后端)就是 package.json。
package.json:是 npm 管理的项目中最核心的配置文件,位于项目根目录,用于描述项目的元信息、依赖关系、脚本命令等关键信息,是 npm 进行依赖管理、脚本执行、包发布的基础。
初始化 package.json
创建方式:
我们可以创建一个 package.json 文件:
手动创建:
在项目根目录新建
package.json
并填写字段。自动生成:
执行
npm init
,通过交互问答生成(加-y
可跳过交互,直接生成默认配置):bashnpm init -y # 快速生成基础 package.json
生成结果:
json{ "name": "learn-npm", "version": "1.0.0", "description": "", "main": "main.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "author": "", "license": "ISC" }
示例:Vue CLI4 / Vue CLI2 配置:
Vue CLI4 对脚手架创建的项目进行了简化,CLI2 创建的项目更加详细:
{
"name": "my-vue",
"version": "0.1.0",
"private": true,
"scripts": {
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
"lint": "vue-cli-service lint"
},
"dependencies": {
"core-js": "^3.6.5",
"vue": "^2.6.11"
},
"devDependencies": {
"@vue/cli-plugin-babel": "~4.5.0",
"@vue/cli-plugin-eslint": "~4.5.0",
"@vue/cli-service": "~4.5.0",
"babel-eslint": "^10.1.0",
"eslint": "^6.7.2",
"eslint-plugin-vue": "^6.2.2",
"vue-template-compiler": "^2.6.11"
},
"browserslist": ["> 1%", "last 2 versions", "not dead"]
}
{
"name": "vuerouterbasic",
"version": "1.0.0",
"description": "A Vue.js project",
"author": "'coderwhy' <'coderwhy@gmail.com'>",
"private": true,
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "npm run dev",
"build": "node build/build.js"
},
"dependencies": {
"vue": "^2.5.2",
"vue-router": "^3.0.1"
},
"devDependencies": {
"autoprefixer": "^7.1.2",
"babel-core": "^6.22.1",
"babel-helper-vue-jsx-merge-props": "^2.0.3",
"babel-loader": "^7.1.1",
"babel-plugin-syntax-jsx": "^6.18.0",
"babel-plugin-transform-runtime": "^6.22.0",
"babel-plugin-transform-vue-jsx": "^3.5.0",
"babel-preset-env": "^1.3.2",
"babel-preset-stage-2": "^6.22.0",
"chalk": "^2.0.1",
"copy-webpack-plugin": "^4.0.1",
"css-loader": "^0.28.0",
"extract-text-webpack-plugin": "^3.0.0",
"file-loader": "^1.1.4",
"friendly-errors-webpack-plugin": "^1.6.1",
"html-webpack-plugin": "^2.30.1",
"node-notifier": "^5.1.2",
"optimize-css-assets-webpack-plugin": "^3.2.0",
"ora": "^1.2.0",
"portfinder": "^1.0.13",
"postcss-import": "^11.0.0",
"postcss-loader": "^2.0.8",
"postcss-url": "^7.2.1",
"rimraf": "^2.6.0",
"semver": "^5.3.0",
"shelljs": "^0.7.6",
"uglifyjs-webpack-plugin": "^1.1.1",
"url-loader": "^0.5.8",
"vue-loader": "^13.3.0",
"vue-style-loader": "^3.0.1",
"vue-template-compiler": "^2.5.2",
"webpack": "^3.6.0",
"webpack-bundle-analyzer": "^2.9.0",
"webpack-dev-server": "^2.9.1",
"webpack-merge": "^4.1.0"
},
"engines": {
"node": ">= 6.0.0",
"npm": ">= 3.0.0"
},
"browserslist": ["> 1%", "last 2 versions", "not ie <= 8"]
}
字段解析
核心字段
package.json 由一系列键值对组成,以下是最常用的核心字段:
基本元信息字段:
- name:必填,项目名称。发布到 npm 时必须唯一,小写,可包含
-
或_
。 - version:必填,版本号,必须遵循 语义化版本。
- description:项目描述。
- author:作者信息(格式:
姓名 <邮箱> (个人主页)
,或仅姓名)。 - license:开源协议(如
MIT
、Apache-2.0
,说明用户如何使用此项目)。 - private:布尔值,项目是否私有。设为
true
时禁止将项目发布到 npm 仓库。 - main:项目入口文件(默认
index.js
,当其他包引入当前包时,会加载此文件)。
依赖管理字段:
- dependencies:生产环境依赖,项目运行时必须的包,会被打包到最终产物中。
- devDependencies:开发环境依赖,仅开发时需要的包,不会被打包到生产环境,安装时需加
-D
。 - peerDependencies:对等依赖,声明当前包与其他包的兼容版本(常用于插件开发)。
脚本命令字段:
- scripts:自定义脚本命令,通过
npm run <脚本名>
执行,用于启动、测试、打包等。
生命周期钩子:
- pre<脚本名>:在目标脚本执行前运行。
- post<脚本名>:在目标脚本执行后运行。
其他重要字段:
- repository:项目代码仓库地址(如 GitHub 链接),方便他人查看源码。
- bugs:问题反馈地址(如 GitHub Issues)。
- homepage:项目主页(如官网、文档地址)。
- engines:指定项目运行所需的 Node.js 或 npm 版本(避免环境不兼容)。
- browserslist:声明前端项目兼容的浏览器范围(供 babel、autoprefixer 等工具使用)。
main
main:项目入口文件(默认 index.js
,当其他包引入当前包时,会加载此文件)。
包查找流程(以axios为例):
在项目中使用 require() 引入 axios
jsconst axios = require('axios')
在 node_modules/axios 目录中找到 package.json 配置文件的 main 字段,找到 axios 的入口文件
访问找到的入口文件
scripts
scripts:自定义脚本命令,通过 npm run <脚本名>
执行,用于启动、测试、打包等。
pre<脚本名>:在目标脚本执行前运行。
post<脚本名>:在目标脚本执行后运行。
示例:配置脚本 npm run start
自定义脚本:node 在终端运行 js 脚本是通过以下命令:
shnode ./src/main.js
配置脚本:我们可以在 package.json 的 scripts 字段添加脚本命令:
json'scripts': { 'start': 'node ./src/main.js' }
运行脚本:配置完成后,我们可以通过
npm run <key>
以下命令来执行省略 run:常用的
start / test / stop / restart
可以省略掉 runshnpm run start # 省略 run npm start
dependencies
dependencies:生产环境依赖,项目运行时必须的包,会被打包到最终产物中。
项目分享流程:
记录安装过的包:
在项目开发过程中每次执行
npm i <包>
命令安装包时,都会在dependencies
或devDependencies
中记录安装的包名和版本信息。分享项目:
由于 node_modules 目录中安装了很多包,造成了它体积会非常大,文件非常多。直接复制分享很耗时。
因此在日常分享项目时,我们会先删除 node_modules ,再分享项目。
接收并重新安装项目:
其他人下载好项目后,直接执行
npm i
命令可以根据 dependencies 和 devDependencies 字段的记录重新安装对应版本的包。
devDependencies
devDependencies:开发环境依赖,仅开发时需要的包,不会被打包到生产环境,安装时需加 -D
。
一些包在生产环境是不需要的(如 webpack、babel 等),此时我们会通过以下命令将它安装到 devDependencies 属性中;
npm install webpack --save-dev
--save
:简写:-S
,默认省略,用于将依赖包信息加入到生产环境依赖 dependencies 中。--save-dev
:简写:-D
,用于将依赖包信息加入到开发环境依赖 devDependencies 中。
peerDependencies
peerDependencies:对等依赖,声明当前包与其他包的兼容版本(常用于插件开发)。
对等依赖:用于声明当前包与其他核心包的兼容版本范围,并要求使用当前包的开发者(宿主项目)手动安装符合范围的核心包。
为什么需要 peerDependencies:
想象一个场景:你开发了一个 React 插件(如 react-plugin),这个插件必须依赖 React 才能运行。如果用普通的 dependencies 声明依赖,会导致:
- 插件安装时,npm 会自动下载 React 到插件自己的 node_modules 目录。 宿主项目(使用插件的项目)本身也会安装 React,最终可能出现多个 React 版本共存(项目的 React + 插件自带的 React)。
- 这会引发严重问题(如 React 上下文冲突、组件复用失败等)。
peerDependencies 正是为解决这类问题而生:它不自动安装依赖,而是要求宿主项目必须安装符合版本范围的核心包,插件直接使用宿主项目已安装的版本,避免重复和冲突。
package-lock.json
概述【
package-lock.json 文件:
{
"name": "learn-npm",
"version": "1.0.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
"axios": {
"version": "0.20.0",
"resolved": "https://registry.npmjs.org/axios/-/axios-0.20.0.tgz",
"integrity": "sha512-ANA4rr2BDcmmAQLOKft2fufrtuvlqR+cXNNinUmvfeSNCOF98PZL+7M/v1zIdGo7OLjEA9J2gXJL+j4zGsl0bA==",
"requires": {
"follow-redirects": "^1.10.0"
}
},
"follow-redirects": {
"version": "1.13.0",
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.0.tgz",
"integrity": "sha512-aq6gF1BEKje4a9i9+5jimNFIpq4Q1WiwBToeRK5NvZBd/TRsmW8BsJfOEGkr76TbOyPVD3OVDN910EcUNtRYEA=="
}
}
}
核心字段【
package-lock.json 文件解析:
name:项目的名称;
version:项目的版本;
lockfileVersion:lock 文件的版本;
requires:使用 requires 来跟着模块的依赖关系;
dependencies:项目的依赖
当前项目依赖 axios,但是 axios 依赖 follow-redireacts;
axios 中的属性如下:
- version 表示实际安装的 axios 的版本;
- resolved 用来记录下载的地址,registry 仓库中的位置;
- requires 记录当前模块的依赖;
- integrity 用来从缓存中获取索引,再通过索引去获取压缩包文件;
SemVer 版本规范
SemVer 介绍@
SemVer 官网:https://semver.org/lang/zh-CN/
我们会发现安装的依赖版本出现:^2.0.3
或~2.0.3
,这是什么意思呢?
SemVer(Semantic Versioning,语义化版本规范 ):是一套用于规范软件版本号命名的标准,让开发者和用户能通过版本号直观了解软件的更新性质(如是否兼容、是否新增功能、是否修复 bug 等),从而简化依赖管理和版本控制。
npm 的包通常遵循 SemVer 规范,并通过版本范围符号定义依赖的允许更新范围,最终通过 package-lock.json
实现精确版本锁定。
SemVer 的核心格式:
遵循 SemVer 的版本号由三部分组成,格式为:X.Y.Z
,分别代表:
- X 主版本号(Major):当软件发生不兼容的 API 变更(升级后可能导致现有代码报错)时递增。
- Y 次版本号(Minor):当软件新增功能,但保持向后兼容(升级后现有代码可正常运行)时递增。
- Z 修订号(Patch):当软件仅修复 bug,且完全向后兼容(不影响现有功能)时递增。
版本范围@
版本范围控制:定义允许的更新范围:
在 package.json 中,依赖的版本通常不是固定的某个版本,而是通过 版本范围符号 定义 “允许安装的版本区间”,npm 会根据范围自动选择最合适的版本。
精确版本(无符号)
直接指定具体版本号(如
1.2.3
),表示仅允许安装该版本,不接受任何更新。json{ "lodash": "4.17.21" } // 只能安装 4.17.21 版本
兼容更新(
^
符号)允许 次版本号和补丁版本号更新,但不允许主版本号更新(保证不引入不兼容变更)。
规则:
- 若主版本号 > 0:
^1.2.3
→ 允许1.2.3
≤ 版本 <2.0.0
- 若主版本号 = 0:表示不稳定版本,
^0.2.3
→ 允许0.2.3
≤ 版本 <0.3.0
(仅允许补丁更新)
json{ "express": "^4.18.2" } // 可安装 4.18.2、4.19.0 等,但不允许 5.0.0
- 若主版本号 > 0:
补丁更新(
~
符号)仅允许 补丁版本号更新,次版本号和主版本号保持不变(仅接受 bug 修复)。
规则:
~1.2.3
:允许1.2.3
≤ 版本 <1.3.0
~1.2
:(等价于~1.2.0
)→ 同上
json{ "axios": "~1.6.8" } // 可安装 1.6.8、1.6.9 等,但不允许 1.7.0
任意版本(
*
符号)允许 所有版本(不推荐,可能引入不兼容变更)。
json{ "moment": "*" } // 会安装最新版本(如 2.30.1,未来可能升级到 3.x)
范围区间(
>
、<
、>=
、<=
、-
)通过比较符号或区间定义更灵活的范围。
json{ "react": ">=18.0.0 <19.0.0", // 允许 18.x 所有版本 "vue": "3.2.0 - 3.4.0" // 允许 3.2.0 到 3.4.0 之间的版本(包含首尾) }
版本配置字段
engines
engines:指定项目运行所需的 Node.js 或 npm 版本(避免环境不兼容)。
- engines 属性用于指定 Node 和 NPM 的版本号;
- 在安装的过程中,会先检查对应的引擎版本,如果不符合就会报错;
- 事实上也可以指定所在的操作系统
"os" : [ "darwin", "linux" ]
,只是很少用到;
browserslist
browserslist:声明前端项目兼容的浏览器范围(供 babel、autoprefixer 等工具使用)。
- 用于配置打包后的 JavaScript 浏览器的兼容情况,参考;
- 否则我们需要手动的添加 polyfills 来让支持某些语法;
- 也就是说它是为 webpack 等打包工具服务的一个属性(这里不是详细讲解 webpack 等工具的工作原理,所以不再给出详情);
npm 常用命令
npm install
:核心功能是从 npm 仓库下载依赖包到本地,并通过配置文件(npm install
package.json
和 package-lock.json
)记录依赖信息,确保项目环境的一致性。
全局/局部安装
npm 安装依赖分为两种情况:
全局安装(global install,工具类依赖):
语法:安装时添加
--global
/-g
参数。安装位置:全局安装的包会被安装到系统全局目录(Linux/macOS 的
~/.npm
,Windows 的%AppData%\npm
)。同步到环境变量:全局安装的包会同步添加到系统的环境变量中。
使用:可在任何项目中通过命令行直接调用(通常用于脚手架、命令行工具等)。
注意:全局安装的包不会出现在项目的
package.json
中,也不会影响当前项目的node_modules
。
shnpm install <包名> -g
本地安装(local install):
本地安装会在当前目录下产生一个
node_modules
文件夹,安装包的 require 查找顺序见: require-查找规则。本地安装又分为:
安装生产依赖(dependencies):
语法:安装时添加
--save
/-S
参数(可以省略)。生产依赖:是项目运行时必须的包(如框架、核心库等),会被添加到
package.json
的dependencies
字段。
shnpm install <包名> # 省略 -S / --save npm install <包名> -S npm install <包名> --save
安装开发依赖(devDependencies):
语法:安装时添加
--save-dev
/-D
参数。开发依赖:是仅开发阶段需要的工具(如代码检查、打包、测试工具等),不会被包含在生产环境的最终产物中,会被添加到
package.json
的devDependencies
字段。
shnpm install <包名> -D npm install <包名> --save-dev
安装 package.json 中的所有依赖:
当从代码仓库克隆项目或拿到一个新项目时,执行不带包名的
npm install
可自动安装package.json
中声明的所有依赖(包括dependencies
和devDependencies
)。shnpm install # 或 npm i
执行逻辑:
- 若存在
package-lock.json
:严格按照其中记录的精确版本安装(确保与上次安装完全一致)。 - 若不存在
package-lock.json
:根据package.json
的版本范围解析并安装最新兼容版本,然后生成package-lock.json
。
- 若存在
从非官方仓库安装依赖:
npm install 支持从多种来源安装包,不限于 npm 官方仓库:
GitHub 仓库:
直接安装 GitHub 上的开源项目
bash# 语法格式: npm install github:<用户名>/<包名>#<分支名> npm install github:vuejs/vue # 安装 Vue 官方仓库的最新代码 npm install github:facebook/react#v18.2.0 # 安装指定标签(v18.2.0)的版本
本地路径:
安装本地开发中的包(常用于调试自己开发的依赖)
bashnpm install ../my-local-package # 安装同级目录下的本地包
URL 地址:
直接安装
.tgz
格式的包压缩文件bashnpm install https://registry.npmjs.org/axios/-/axios-1.6.8.tgz
npm install 原理@【
很多同学之情应该已经会了 npm install <package>
,但是你是否思考过它的内部原理呢?
- 执行
npm install
它背后帮助我们完成了什么操作? - 我们会发现还有一个成为 package-lock.json 的文件,它的作用是什么?
- 从 npm5 开始,npm 支持缓存策略(来自 yarn 的压力),缓存有什么作用呢?
npm install 原理图:
npm install 会检测是有 package-lock.json 文件:
没有 lock 文件
- 分析依赖关系,这是因为我们可能包会依赖其他的包,并且多个包之间会产生相同依赖的情况;
- 从 registry 仓库中下载压缩包(如果我们设置了镜像,那么会从镜像服务器下载压缩包);
- 获取到压缩包后会对压缩包进行缓存(从 npm5 开始有的);
- 将压缩包解压到项目的 node_modules 文件夹中(前面我们讲过,require 的查找顺序会在该包下面查找)
有 lock 文件
- 检测 lock 中包的版本是否和 package.json 中一致(会按照 semver 版本规范检测);
- 不一致,那么会重新构建依赖关系,直接会走顶层的流程;
- 一致的情况下,会去优先查找缓存
- 没有找到,会从 registry 仓库下载,直接走顶层流程;
- 查找到,会获取缓存中的压缩文件,并且将压缩文件解压到 node_modules 文件夹中;
- 检测 lock 中包的版本是否和 package.json 中一致(会按照 semver 版本规范检测);
其他 npm 命令
我们这里再介绍几个比较常用的:
npm uninstall <包名>
:卸载某个依赖包。npm rebuild
:强制重新构建包。npm cache clean
:清除缓存。npm config get cache
:获取缓存所在目录。npm config list
:查看配置列表。- 更多 npm 命令:https://docs.npmjs.com/cli-documentation/cli
npx
npx 是 npm5.2 之后自带的一个命令。
npx 的作用非常多,但是比较常见的是使用它来调用项目中的某个模块的指令。
我们以 webpack 为例:
- 全局安装的是 webpack5.1.3
- 项目安装的是 webpack3.6.0
如果我在终端执行 webpack --version
使用的是哪一个命令呢?
- 显示结果会是
webpack 5.1.3
,事实上使用的是全局的,为什么呢? - 原因非常简单,在当前目录下找不到 webpack 时,就会去全局找,并且执行命令;
那么如何使用项目(局部)的 webpack,常见的是两种方式:
- 方式一:明确查找到 node_module 下面的 webpack
- 方式二:在
scripts
定义脚本,来执行 webpack;
方式一:在终端中使用如下命令(在项目根目录下)
./node_modules/.bin/webpack --version
方式二:修改 package.json 中的 scripts
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"webpack": "webpack --version"
},
终端中执行:
npm run webpack
但是这两种方式都有一点点麻烦,更好的办法是直接使用 npx:
npx webpack --version
npx 的原理非常简单,它会到当前目录的 node_modules/.bin 目录下查找对应的命令;
yarn【
yarn 介绍【
另一个 node 包管理工具 yarn:
- yarn 是由 Facebook、Google、Exponent 和 Tilde 联合推出了一个新的 JS 包管理工具;
- yarn 是为了弥补 npm 的一些缺陷而出现的;
- 早期的 npm 存在很多的缺陷,比如安装依赖速度很慢、版本依赖混乱等等一系列的问题;
- 虽然从 npm5 版本开始,进行了很多的升级和改进,但是依然很多人喜欢使用 yarn;
安装 yarn【
常用命令【
这里给出一张常用命令的对比
功能场景 | Yarn 命令 | npm 命令 |
---|---|---|
初始化项目 | yarn init 或 yarn init -y | npm init 或 npm init -y |
安装生产依赖 | yarn add <包名> | npm install <包名> |
安装开发依赖 | yarn add <包名> -D | npm install <包名> -D |
全局安装 | yarn global add <包名> | npm install <包名> -g |
卸载依赖 | yarn remove <包名> | npm uninstall <包名> |
安装 package.json 所有依赖 | yarn 或 yarn install | npm install |
执行脚本 | yarn <脚本名>(如 yarn dev) | npm run <脚本名>(如 npm run dev) |
更新依赖 | yarn upgrade <包名> | npm update <包名> |
查看依赖树 | yarn why <包名> | npm ls <包名> |
清理缓存 | yarn cache clean | npm cache clean --force |
yarn.lock【
cnpm【
cnpm 介绍【
安装 cnpm【
常用命令【
替代方案【
由于一些特殊的原因,某些情况下我们没办法很好的从 https://registry.npmjs.org
下载下来一些需要的包。
查看 npm 镜像:
npm config get registry # npm config get registry
我们可以直接设置 npm 的镜像:
npm config set registry https://registry.npm.taobao.org
但是对于大多数人来说(比如我),并不希望将 npm 镜像修改了:
- 第一,不太希望随意修改 npm 原本从官方下来包的渠道;
- 第二,担心某天淘宝的镜像挂了或者不维护了,又要改来改去;
这个时候,我们可以使用 cnpm,并且将 cnpm 设置为淘宝的镜像:
npm install -g cnpm --registry=https://registry.npm.taobao.org
cnpm config get registry # https://r.npm.taobao.org/
pnpm【
Monorepo
发布包【
npm login
:npm publish
:npm version patch
:npm version minor
:npm version major
:npm unpublish <包名>@<版本号>
:npm deprecate
: